home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / catD / cmn_err.z / cmn_err
Encoding:
Text File  |  2001-04-17  |  20.8 KB  |  265 lines

  1.  
  2.  
  3.  
  4. ccccmmmmnnnn____eeeerrrrrrrr((((DDDD3333))))                                                        ccccmmmmnnnn____eeeerrrrrrrr((((DDDD3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _cccc_mmmm_nnnn______eeee_rrrr_rrrr - display an error message or panic the system
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_cccc_mmmm_nnnn______eeee_rrrr_rrrr_...._hhhh_>>>>
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_dddd_dddd_iiii_...._hhhh_>>>>
  14.  
  15.      _vvvv_oooo_iiii_dddd _cccc_mmmm_nnnn______eeee_rrrr_rrrr_((((_iiii_nnnn_tttt _l_e_v_e_l_,,,, _cccc_hhhh_aaaa_rrrr _****_f_o_r_m_a_t_,,,, _...._...._.... _////_**** _aaaa_rrrr_gggg_ssss _****_////_))))_;;;;
  16.      _vvvv_oooo_iiii_dddd _cccc_mmmm_nnnn______eeee_rrrr_rrrr______tttt_aaaa_gggg_((((_iiii_nnnn_tttt _s_e_q_n_u_m_b_e_r_,,,,_iiii_nnnn_tttt _l_e_v_e_l_,,,, _cccc_hhhh_aaaa_rrrr _****_f_o_r_m_a_t_,,,, _...._...._.... _////_**** _aaaa_rrrr_gggg_ssss _****_////_))))_;;;;
  17.  
  18.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee  _<<<<_ssss_tttt_dddd_aaaa_rrrr_gggg_...._hhhh_>>>>
  19.      _vvvv_oooo_iiii_dddd _iiii_cccc_mmmm_nnnn______eeee_rrrr_rrrr_((((_iiii_nnnn_tttt _l_e_v_e_l_,,,, _cccc_hhhh_aaaa_rrrr _****_f_o_r_m_a_t_,,,, _vvvv_aaaa______llll_iiii_ssss_tttt _a_p_))))_;;;;
  20.  
  21.  
  22.    AAAArrrrgggguuuummmmeeeennnnttttssss
  23.      _s_e_q_n_u_m_b_e_r
  24.           Unique sequence number for tracking particular message through
  25.           _E_m_b_e_d_d_e_d _S_u_p_p_o_r_t _P_a_r_t_n_e_r (_E_S_P) subsystem.
  26.  
  27.      _l_e_v_e_l
  28.           Indicates the severity of the error condition.
  29.  
  30.      _f_o_r_m_a_t
  31.           The message to be displayed.
  32.  
  33.      _a_r_g_s The set of arguments passed with the message being displayed.
  34.  
  35.      _a_p   An argument list of type va_list, as documented in _ssss_tttt_dddd_aaaa_rrrr_gggg(5).
  36.  
  37. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  38.      These functions display a message on the console and/or store it in the
  39.      kernel buffer _pppp_uuuu_tttt_bbbb_uuuu_ffff.  They can also initiate a system panic. In addition
  40.      to above functionality _cccc_mmmm_nnnn______eeee_rrrr_rrrr______tttt_aaaa_gggg allows to detect and identify message
  41.      using unique _E_S_P sequence number. It can also activate different user
  42.      defined actions through _E_S_P.
  43.  
  44.    RRRReeeettttuuuurrrrnnnn VVVVaaaalllluuuueeeessss
  45.      None
  46.  
  47. UUUUSSSSAAAAGGGGEEEE
  48.    sssseeeeqqqqnnnnuuuummmmbbbbeeeerrrr AAAArrrrgggguuuummmmeeeennnntttt
  49.      The unique sequence number is used for tracking the particular message in
  50.      the Embedded Support Partner environment. For more details see _eeee_ssss_pppp(1).
  51.  
  52.    lllleeeevvvveeeellll AAAArrrrgggguuuummmmeeeennnntttt
  53.      Valid values for _l_e_v_e_l are:
  54.  
  55.           _CCCC_EEEE______CCCC_OOOO_NNNN_TTTT
  56.                  Used to continue a previous message or to display an
  57.                  informative message not connected with an error.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ccccmmmmnnnn____eeeerrrrrrrr((((DDDD3333))))                                                        ccccmmmmnnnn____eeeerrrrrrrr((((DDDD3333))))
  71.  
  72.  
  73.  
  74.           _CCCC_EEEE______DDDD_EEEE_BBBB_UUUU_GGGG
  75.                  Used to display an informative message which is generally
  76.                  expected to be of use only when debugging the associated
  77.                  code.
  78.  
  79.           _CCCC_EEEE______NNNN_OOOO_TTTT_EEEE
  80.                  Used to display a message preceded with ``_NNNN_OOOO_TTTT_IIII_CCCC_EEEE_:::: .''  This
  81.                  message is used to report system events that do not
  82.                  necessarily require action, but may interest the system
  83.                  administrator.  For example, a message saying that a sector
  84.                  on a disk needs to be accessed repeatedly before it can be
  85.                  accessed correctly might be noteworthy.
  86.  
  87.           _CCCC_EEEE______WWWW_AAAA_RRRR_NNNN
  88.                  Used to display a message preceded with ``_WWWW_AAAA_RRRR_NNNN_IIII_NNNN_GGGG_:::: .''  This
  89.                  message is used to report system events that require
  90.                  attention, such as those where if an action is not taken, the
  91.                  system may panic or provide reduced functionality.
  92.                  Generally, WARNINGs are associated with situations that are
  93.                  less severe than ALERTs.  For example, when a peripheral
  94.                  device does not initialize correctly, this level might be
  95.                  used.
  96.  
  97.           _CCCC_EEEE______AAAA_LLLL_EEEE_RRRR_TTTT
  98.                  Used to display a message preceded with ``_AAAA_LLLL_EEEE_RRRR_TTTT_:::: .''  This
  99.                  message is used to report system events that require
  100.                  immediate attention, such as those where if an action is not
  101.                  taken, the system may panic or provide reduced functionality.
  102.                  Generally, ALERTs are associated with situations that are
  103.                  more severe than WARNINGs.  For example, when a networking
  104.                  device loses its carrier, this level might be used.
  105.  
  106.           _CCCC_EEEE______PPPP_AAAA_NNNN_IIII_CCCC
  107.                  Used to display a message preceded with ``_PPPP_AAAA_NNNN_IIII_CCCC_:::: ,'' and
  108.                  panic the system.  Drivers should use this level only for
  109.                  debugging or in the case of severe errors that indicate that
  110.                  the system cannot continue to function.  This level halts
  111.                  processing.
  112.  
  113.    ffffoooorrrrmmmmaaaatttt AAAArrrrgggguuuummmmeeeennnntttt
  114.      The _f_o_r_m_a_t is a character string giving a message pattern in a style
  115.      similar to that of f4printf(3S).
  116.  
  117.      By default, the message is sent both to the system console and to the
  118.      circular kernel buffer _pppp_uuuu_tttt_bbbb_uuuu_ffff.  When the first character in _f_o_r_m_a_t is a
  119.      circumflex (``_^^^^''), the message goes only to the console.  When the first
  120.      character in _f_o_r_m_a_t is an exclamation point (``_!!!!''), the message goes
  121.      only to _pppp_uuuu_tttt_bbbb_uuuu_ffff.
  122.  
  123.      The size of the kernel buffer _pppp_uuuu_tttt_bbbb_uuuu_ffff is defined by the kernel variable
  124.      _pppp_uuuu_tttt_bbbb_uuuu_ffff_ssss_zzzz.  Driver developers or administrators can display the _pppp_uuuu_tttt_bbbb_uuuu_ffff
  125.      buffer using appropriate debugging or administrative tools such as
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ccccmmmmnnnn____eeeerrrrrrrr((((DDDD3333))))                                                        ccccmmmmnnnn____eeeerrrrrrrr((((DDDD3333))))
  137.  
  138.  
  139.  
  140.      _iiii_dddd_bbbb_gggg(1M).
  141.  
  142.           _cccc_mmmm_nnnn______eeee_rrrr_rrrr appends _\\\\_nnnn to each _f_o_r_m_a_t string, even when a message is
  143.           sent to _pppp_uuuu_tttt_bbbb_uuuu_ffff, except when _l_e_v_e_l is _CCCC_EEEE______CCCC_OOOO_NNNN_TTTT.
  144.  
  145.           Valid conversion specifications are %_ssss, %_uuuu, %_dddd, %_oooo, and %_xxxx.  The
  146.           _cccc_mmmm_nnnn______eeee_rrrr_rrrr function is otherwise similar to the _pppp_rrrr_iiii_nnnn_tttt_ffff(3S) library
  147.           subroutine in its interpretation of the _f_o_r_m_a_t string, except that
  148.           _cccc_mmmm_nnnn______eeee_rrrr_rrrr does not accept length specifications in conversion
  149.           specifications.  For example, %_3333_dddd is invalid and will be treated as
  150.           a literal string, resulting in a mismatch of arguments.
  151.  
  152.    aaaarrrrggggssss AAAArrrrgggguuuummmmeeeennnntttt
  153.      Any argument within the range of supported conversion specifications can
  154.      be passed.
  155.  
  156.    aaaapppp AAAArrrrgggguuuummmmeeeennnntttt
  157.      The _iiii_cccc_mmmm_nnnn______eeee_rrrr_rrrr function is functionally the same as _cccc_mmmm_nnnn______eeee_rrrr_rrrr except that it
  158.      takes a variable argument list as prepared by the _ssss_tttt_dddd_aaaa_rrrr_gggg(5) macros.  This
  159.      allows the driver developer to create debugging functions that take
  160.      arguments similar to those of _cccc_mmmm_nnnn______eeee_rrrr_rrrr, but that add extra features or
  161.      perform conditional actions.
  162.  
  163.    GGGGeeeennnneeeerrrraaaallll CCCCoooonnnnssssiiiiddddeeeerrrraaaattttiiiioooonnnnssss
  164.      At times, a driver may encounter error conditions requiring the attention
  165.      of a system console monitor.  These conditions may mean halting the
  166.      system; however, this must be done with caution.  Except during the
  167.      debugging stage, or in the case of a serious, unrecoverable error, a
  168.      driver should never stop the system.
  169.  
  170.      The _cccc_mmmm_nnnn______eeee_rrrr_rrrr function with the _CCCC_EEEE______CCCC_OOOO_NNNN_TTTT argument can be used by driver
  171.      developers as a driver code debugging tool.  However, using _cccc_mmmm_nnnn______eeee_rrrr_rrrr in
  172.      this capacity can change system timing characteristics.
  173.  
  174.    LLLLeeeevvvveeeellll
  175.      Initialization, Base or Interrupt.
  176.  
  177.    SSSSyyyynnnncccchhhhrrrroooonnnniiiizzzzaaaattttiiiioooonnnn CCCCoooonnnnssssttttrrrraaaaiiiinnnnttttssss
  178.      Does not sleep.
  179.  
  180.      If _l_e_v_e_l is _CCCC_EEEE______PPPP_AAAA_NNNN_IIII_CCCC, then driver-defined basic locks, read/write locks,
  181.      and sleep locks may not be held across calls to this function.  For other
  182.      levels, locks may be held.
  183.  
  184.    EEEExxxxaaaammmmpppplllleeeessss
  185.      The _cccc_mmmm_nnnn______eeee_rrrr_rrrr function can record tracing and debugging information only in
  186.      the _pppp_uuuu_tttt_bbbb_uuuu_ffff buffer (lines 12 and 13) or display problems with a device
  187.      only on the system console (lines 17 and 18).  The _cccc_mmmm_nnnn______eeee_rrrr_rrrr______tttt_aaaa_gggg function
  188.      allows to trace particular error event (lines 24 and 25) through _E_m_b_e_d_d_e_d
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. ccccmmmmnnnn____eeeerrrrrrrr((((DDDD3333))))                                                        ccccmmmmnnnn____eeeerrrrrrrr((((DDDD3333))))
  203.  
  204.  
  205.  
  206.      _S_u_p_p_o_r_t _P_a_r_t_n_e_r subsystem.
  207.  
  208.       _1111  _ssss_tttt_rrrr_uuuu_cccc_tttt  _dddd_eeee_vvvv_iiii_cccc_eeee _{{{{                   _////_**** _dddd_eeee_vvvv_iiii_cccc_eeee _rrrr_eeee_gggg_iiii_ssss_tttt_eeee_rrrr_ssss _llll_aaaa_yyyy_oooo_uuuu_tttt _****_////
  209.           _...._...._....
  210.       _2222   _iiii_nnnn_tttt _ssss_tttt_aaaa_tttt_uuuu_ssss_;;;;                    _////_**** _dddd_eeee_vvvv_iiii_cccc_eeee _ssss_tttt_aaaa_tttt_uuuu_ssss _wwww_oooo_rrrr_dddd _****_////
  211.       _3333  _}}}}_;;;;
  212.  
  213.       _4444  _eeee_xxxx_tttt_eeee_rrrr_nnnn _ssss_tttt_rrrr_uuuu_cccc_tttt _dddd_eeee_vvvv_iiii_cccc_eeee _xxxx_xxxx______dddd_eeee_vvvv_[[[[_]]]]_;;;;     _////_**** _pppp_hhhh_yyyy_ssss_iiii_cccc_aaaa_llll _dddd_eeee_vvvv_iiii_cccc_eeee _rrrr_eeee_gggg_iiii_ssss_tttt_eeee_rrrr_ssss _****_////
  214.       _5555  _eeee_xxxx_tttt_eeee_rrrr_nnnn _iiii_nnnn_tttt _xxxx_xxxx______cccc_nnnn_tttt_;;;;                 _////_**** _nnnn_uuuu_mmmm_bbbb_eeee_rrrr _oooo_ffff _pppp_hhhh_yyyy_ssss_iiii_cccc_aaaa_llll _dddd_eeee_vvvv_iiii_cccc_eeee_ssss _****_////
  215.          _...._...._....
  216.       _6666  _iiii_nnnn_tttt
  217.       _7777  _xxxx_xxxx_oooo_pppp_eeee_nnnn_((((_dddd_eeee_vvvv______tttt _****_dddd_eeee_vvvv_pppp_,,,, _iiii_nnnn_tttt _ffff_llll_aaaa_gggg_,,,, _iiii_nnnn_tttt _oooo_tttt_yyyy_pppp_,,,, _cccc_rrrr_eeee_dddd______tttt _****_cccc_rrrr_pppp_))))
  218.       _8888  _{{{{
  219.       _9999   _ssss_tttt_rrrr_uuuu_cccc_tttt _dddd_eeee_vvvv_iiii_cccc_eeee _****_dddd_pppp_;;;;
  220.  
  221.      _1111_0000   _dddd_pppp _==== _xxxx_xxxx______dddd_eeee_vvvv_[[[[_gggg_eeee_tttt_mmmm_iiii_nnnn_oooo_rrrr_((((_****_dddd_eeee_vvvv_pppp_))))_]]]]_;;;;  _////_**** _gggg_eeee_tttt _dddd_eeee_vvvv _rrrr_eeee_gggg_iiii_ssss_tttt_eeee_rrrr_ssss _****_////
  222.      _1111_1111  _####_iiii_ffff_dddd_eeee_ffff _DDDD_EEEE_BBBB_UUUU_GGGG                       _////_**** _iiii_nnnn _dddd_eeee_bbbb_uuuu_gggg_gggg_iiii_nnnn_gggg _mmmm_oooo_dddd_eeee_,,,, _llll_oooo_gggg _ffff_uuuu_nnnn_cccc_tttt_iiii_oooo_nnnn _cccc_aaaa_llll_llll _****_////
  223.      _1111_2222   _cccc_mmmm_nnnn______eeee_rrrr_rrrr_((((_CCCC_EEEE______DDDD_EEEE_BBBB_UUUU_GGGG_,,,, _""""_!!!!_xxxx_xxxx_oooo_pppp_eeee_nnnn _ffff_uuuu_nnnn_cccc_tttt_iiii_oooo_nnnn _cccc_aaaa_llll_llll_,,,, _dddd_eeee_vvvv _==== _0000_xxxx_%%%%_xxxx_""""_,,,, _****_dddd_eeee_vvvv_pppp_))))_;;;;
  224.      _1111_3333   _cccc_mmmm_nnnn______eeee_rrrr_rrrr_((((_CCCC_EEEE______CCCC_OOOO_NNNN_TTTT_,,,, _""""_!!!! _ffff_llll_aaaa_gggg _==== _0000_xxxx_%%%%_xxxx_""""_,,,, _ffff_llll_aaaa_gggg_))))_;;;;
  225.      _1111_4444  _####_eeee_nnnn_dddd_iiii_ffff
  226.  
  227.      _1111_5555   _////_**** _dddd_iiii_ssss_pppp_llll_aaaa_yyyy _dddd_eeee_vvvv_iiii_cccc_eeee _pppp_oooo_wwww_eeee_rrrr _ffff_aaaa_iiii_llll_uuuu_rrrr_eeee _oooo_nnnn _ssss_yyyy_ssss_tttt_eeee_mmmm _cccc_oooo_nnnn_ssss_oooo_llll_eeee _****_////
  228.      _1111_6666   _iiii_ffff _((((_((((_dddd_pppp_----_>>>>_ssss_tttt_aaaa_tttt_uuuu_ssss _&&&& _PPPP_OOOO_WWWW_EEEE_RRRR_)))) _====_==== _OOOO_FFFF_FFFF_))))
  229.      _1111_7777        _cccc_mmmm_nnnn______eeee_rrrr_rrrr_((((_CCCC_EEEE______WWWW_AAAA_RRRR_NNNN_,,,, _""""_^^^^_xxxx_xxxx_oooo_pppp_eeee_nnnn_:::: _PPPP_oooo_wwww_eeee_rrrr _iiii_ssss _OOOO_FFFF_FFFF _oooo_nnnn _dddd_eeee_vvvv_iiii_cccc_eeee _%%%%_dddd _pppp_oooo_rrrr_tttt _%%%%_dddd_""""_,,,,
  230.      _1111_8888           _gggg_eeee_tttt_eeee_mmmm_aaaa_jjjj_oooo_rrrr_((((_****_dddd_eeee_vvvv_pppp_))))_,,,, _gggg_eeee_tttt_eeee_mmmm_iiii_nnnn_oooo_rrrr_((((_****_dddd_eeee_vvvv_pppp_))))_))))_;;;;
  231.      _1111_9999
  232.      _2222_0000   _////_**** _ffff_iiii_xxxx _dddd_eeee_vvvv_iiii_cccc_eeee _llll_oooo_wwww _pppp_oooo_wwww_eeee_rrrr _llll_eeee_vvvv_eeee_llll _tttt_hhhh_rrrr_oooo_uuuu_gggg_hhhh _EEEE_SSSS_PPPP _ssss_uuuu_bbbb_ssss_yyyy_ssss_tttt_eeee_mmmm  _****_////
  233.      _2222_1111   _////_**** _IIII_tttt _cccc_aaaa_nnnn _aaaa_cccc_tttt_iiii_vvvv_aaaa_tttt_eeee _ssss_oooo_mmmm_eeee _aaaa_cccc_tttt_iiii_oooo_nnnn_ssss _llll_iiii_kkkk_eeee _ssss_eeee_nnnn_dddd _eeee_mmmm_aaaa_iiii_llll_,,,, _ssss_hhhh_oooo_wwww _pppp_oooo_pppp_uuuu_pppp _****_////
  234.      _2222_2222   _////_**** _wwww_iiii_nnnn_dddd_oooo_wwww _aaaa_nnnn_dddd _oooo_tttt_hhhh_eeee_rrrr_ssss _ffff_oooo_rrrr _tttt_hhhh_iiii_ssss _eeee_vvvv_eeee_nnnn_tttt _****_////
  235.      _2222_3333   _iiii_ffff _((((_((((_dddd_pppp_----_>>>>_ssss_tttt_aaaa_tttt_uuuu_ssss _&&&& _PPPP_OOOO_WWWW_EEEE_RRRR_)))) _====_==== _LLLL_OOOO_WWWW_))))
  236.      _2222_4444        _cccc_mmmm_nnnn______eeee_rrrr_rrrr______tttt_aaaa_gggg_((((_0000_xxxx_5555_8888_7777_3333_5555_,,,, _""""_xxxx_xxxx_oooo_pppp_eeee_nnnn_:::: _PPPP_oooo_wwww_eeee_rrrr _iiii_ssss _LLLL_OOOO_WWWW _oooo_nnnn _dddd_eeee_vvvv_iiii_cccc_eeee _%%%%_dddd _pppp_oooo_rrrr_tttt _%%%%_dddd_""""_,,,,
  237.      _2222_5555           _gggg_eeee_tttt_eeee_mmmm_aaaa_jjjj_oooo_rrrr_((((_****_dddd_eeee_vvvv_pppp_))))_,,,, _gggg_eeee_tttt_eeee_mmmm_iiii_nnnn_oooo_rrrr_((((_****_dddd_eeee_vvvv_pppp_))))_))))_;;;;
  238.  
  239. RRRREEEEFFFFEEEERRRREEEENNNNCCCCEEEESSSS
  240.      printf(3S), stdarg(5), print(D2), esp(1).
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.